Update User
AutomatR.Zendesk.Activities.UpdateUser
The "Update User" activity in AutomatR is part of the Zendesk activities package, allowing automation processes to update user details within Zendesk. This activity is useful for keeping user information synchronized and ensuring accurate user data.
Properties
Name | Description |
---|---|
Input | |
User ID | The ID of the user. Enter an Int64 or an Int64 variable. This is a required field. |
Name | The name of the user. Enter a string or a String variable. |
The primary email address of this user. Enter a string or a String variable. | |
Phone | The primary phone number of this user. Enter a string or a String variable. |
Organization ID | The ID of the user's organization or, if the user has more than one organization memberships, the ID of the user's default organization. Enter an Int64 variable. |
Details | Any details you want to store about the user, such as an address. Enter a string or a String variable. |
Ticket Restriction | Specifies which tickets the user has access to. Enter one of four options: Organization, Groups, Assigned, Requested. |
Time Zone | The user's time zone. Enter a string or a String variable. For example, "Copenhagen". |
Role | Choose the role of the user. Select from the available options. |
Misc | |
Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
Optional | |
Delay | Enter the wait time in seconds (Example: 5 seconds i.e., 5) to start the activity. This is an optional field. |
Output | |
Result | Outputs the updated user details as an IndividualUserResponse. |
Note:
- The user ID is a required field, and it represents the unique identifier of the user whose details you want to update.
- The "Role" property allows you to specify the role of the user. Choose from the available options, and if "Enduser" is selected, it will be mapped to "end-user."
- Ensure that the provided user ID exists in Zendesk before attempting to update the user details.
- If the user ID corresponds to an admin user, the user role cannot be altered.
How to use:
- Drag and drop the "Update User" activity onto the workflow.
- Configure the properties based on the user details you want to update.
- Optionally, configure the delay for synchronization purposes.
- Execute the workflow to update the specified user details in Zendesk.
Example: Consider an example where the "Update User" activity is used to modify the email address and phone number of a user with the ID 123:
Update User:
User ID: 123
Email: "newemail@example.com"
Phone: "+1234567890"
Result: updatedUserDetails
In this example, the activity updates the email address and phone number of the user with ID 123 in Zendesk, and the updated user details are stored in the variable "updatedUserDetails" for further use.